Skip to content

Feature/24 fluent create observer pattern#54

Merged
JerrettDavis merged 2 commits intomainfrom
feature/24-fluent-create-observer-pattern
Oct 10, 2025
Merged

Feature/24 fluent create observer pattern#54
JerrettDavis merged 2 commits intomainfrom
feature/24-fluent-create-observer-pattern

Conversation

@JerrettDavis
Copy link
Copy Markdown
Owner

No description provided.

- PatternKit.Core.Behavioral.Observer.AsyncObserver<TEvent>: added comprehensive XML comments for delegates, members, and Builder, with remarks and exception tags to match Observer<TEvent> standard
- PatternKit.Examples.ObserverDemo.EventHub<TEvent>: documented constructor, factory, subscribe methods, and Publish; documented UserEvent record parameters
- PatternKit.Examples.ObserverDemo.ReactivePrimitives: documented PropertyChangedHub, ObservableVar<T>, and ObservableList<T> public APIs
- PatternKit.Examples.ObserverDemo.ReactiveTransaction: documented enums, LineItem record, ReactiveTransaction and ProfileViewModel public APIs

Build and tests verified locally: solution builds successfully; all tests pass. This ensures DocFX picks up consistent API docs across Observer classes and demos.
@JerrettDavis JerrettDavis requested a review from Copilot October 10, 2025 04:27
@JerrettDavis JerrettDavis self-assigned this Oct 10, 2025
@JerrettDavis JerrettDavis added the documentation Improvements or additions to documentation label Oct 10, 2025
@JerrettDavis JerrettDavis linked an issue Oct 10, 2025 that may be closed by this pull request
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a fluent observer pattern implementation with both synchronous and asynchronous variants. The implementation provides a typed, thread-safe event hub for publishing events to multiple subscribers with configurable error handling policies.

  • Adds Observer<TEvent> for synchronous event publishing with predicate-based filtering
  • Adds AsyncObserver<TEvent> for asynchronous event handling with ValueTask-based delegates
  • Implements reactive primitives (ObservableVar, ObservableList, PropertyChangedHub) for building reactive applications

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
test/PatternKit.Tests/Behavioral/Observer/ObserverTests.cs Test coverage for synchronous Observer pattern with various error handling scenarios
test/PatternKit.Tests/Behavioral/Observer/AsyncObserverTests.cs Test coverage for asynchronous Observer pattern with async delegates
test/PatternKit.Examples.Tests/ObserverDemo/ReactiveViewModelTests.cs Tests for reactive ViewModel example showing dependent properties
test/PatternKit.Examples.Tests/ObserverDemo/ReactiveTransactionTests.cs Tests for reactive transaction example with complex discount calculations
src/PatternKit.Generators/packages.lock.json Package lock file updates for build dependencies
src/PatternKit.Examples/ObserverDemo/SimpleEventHub.cs Example event hub wrapper around Observer pattern
src/PatternKit.Examples/ObserverDemo/ReactiveTransaction.cs Complex reactive transaction example with dependent properties
src/PatternKit.Examples/ObserverDemo/ReactivePrimitives.cs Basic reactive primitives built on Observer pattern
src/PatternKit.Core/Behavioral/Observer/Observer.cs Core synchronous Observer implementation with fluent builder
src/PatternKit.Core/Behavioral/Observer/AsyncObserver.cs Core asynchronous Observer implementation
docs/patterns/toc.yml Documentation table of contents updates
docs/patterns/behavioral/observer/observer.md Documentation for synchronous Observer pattern
docs/patterns/behavioral/observer/asyncobserver.md Documentation for asynchronous Observer pattern
docs/index.md Main documentation index updates
docs/examples/toc.yml Examples table of contents updates
docs/examples/reactive-viewmodel.md Reactive ViewModel example documentation
docs/examples/reactive-transaction.md Reactive transaction example documentation
docs/examples/observer-demo.md Observer demo example documentation

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread src/PatternKit.Core/Behavioral/Observer/Observer.cs
Comment thread test/PatternKit.Tests/Behavioral/Observer/AsyncObserverTests.cs
Comment thread src/PatternKit.Examples/ObserverDemo/ReactiveTransaction.cs
@github-actions
Copy link
Copy Markdown
Contributor

Code Coverage

Summary
  Generated on: 10/10/2025 - 04:28:25
  Coverage date: 10/10/2025 - 04:28:14 - 10/10/2025 - 04:28:22
  Parser: MultiReport (6x Cobertura)
  Assemblies: 3
  Classes: 159
  Files: 66
  Line coverage: 82.8%
  Covered lines: 3796
  Uncovered lines: 786
  Coverable lines: 4582
  Total lines: 13941
  Branch coverage: 72.7% (1242 of 1707)
  Covered branches: 1242
  Total branches: 1707
  Method coverage: 89% (985 of 1106)
  Full method coverage: 82% (908 of 1106)
  Covered methods: 985
  Fully covered methods: 908
  Total methods: 1106

PatternKit.Core                                                                  86.7%
  PatternKit.Behavioral.Chain.ActionChain<T>                                     84.7%
  PatternKit.Behavioral.Chain.ResultChain<T1, T2>                                 100%
  PatternKit.Behavioral.Command.Command<T>                                       54.9%
  PatternKit.Behavioral.Iterator.AsyncFlow<T>                                     100%
  PatternKit.Behavioral.Iterator.AsyncFlowExtensions                              100%
  PatternKit.Behavioral.Iterator.AsyncReplayBuffer<T>                              75%
  PatternKit.Behavioral.Iterator.Flow<T>                                         94.4%
  PatternKit.Behavioral.Iterator.FlowExtensions                                  21.4%
  PatternKit.Behavioral.Iterator.ReplayableSequence<T>                           80.7%
  PatternKit.Behavioral.Iterator.ReplayableSequenceExtensions                     100%
  PatternKit.Behavioral.Iterator.SharedAsyncFlow<T>                               100%
  PatternKit.Behavioral.Iterator.SharedFlow<T>                                   63.1%
  PatternKit.Behavioral.Iterator.WindowSequence                                  92.3%
  PatternKit.Behavioral.Mediator.Mediator                                        88.2%
  PatternKit.Behavioral.Mediator.MediatorHelpers                                   50%
  PatternKit.Behavioral.Mediator.TaskExtensions                                     0%
  PatternKit.Behavioral.Memento.Memento<T>                                       85.3%
  PatternKit.Behavioral.Observer.AsyncObserver<T>                                87.8%
  PatternKit.Behavioral.Observer.Observer<T>                                     96.5%
  PatternKit.Behavioral.Strategy.ActionStrategy<T>                                 97%
  PatternKit.Behavioral.Strategy.AsyncStrategy<T1, T2>                           93.5%
  PatternKit.Behavioral.Strategy.Strategy<T1, T2>                                 100%
  PatternKit.Behavioral.Strategy.TryStrategy<T1, T2>                             95.8%
  PatternKit.Common.Option<T>                                                      80%
  PatternKit.Common.Throw                                                          80%
  PatternKit.Common.TryHandlerExtensions                                         33.3%
  PatternKit.Creational.Builder.BranchBuilder<T1, T2>                             100%
  PatternKit.Creational.Builder.BuilderExtensions                                 100%
  PatternKit.Creational.Builder.ChainBuilder<T>                                   100%
  PatternKit.Creational.Builder.Composer<T1, T2>                                  100%
  PatternKit.Creational.Builder.MutableBuilder<T>                                 100%
  PatternKit.Creational.Factory.Factory<T1, T2>                                  76.9%
  PatternKit.Creational.Factory.Factory<T1, T2, T3>                              76.9%
  PatternKit.Creational.Prototype.Prototype<T>                                    100%
  PatternKit.Creational.Prototype.Prototype<T1, T2>                                90%
  PatternKit.Creational.Singleton.Singleton<T>                                   96.5%
  PatternKit.Structural.Adapter.Adapter<T1, T2>                                  82.2%
  PatternKit.Structural.Bridge.Bridge<T1, T2, T3>                                77.5%
  PatternKit.Structural.Composite.Composite<T1, T2>                              97.3%
  PatternKit.Structural.Decorator.Decorator<T1, T2>                              97.6%
  PatternKit.Structural.Facade.Facade<T1, T2>                                    88.8%
  PatternKit.Structural.Facade.TypedFacade<T>                                    79.4%
  PatternKit.Structural.Facade.TypedFacadeDispatchProxy<T>                       81.8%
  PatternKit.Structural.Facade.TypedFacadeProxyFactory<T>                         100%
  PatternKit.Structural.Flyweight.Flyweight<T1, T2>                              83.3%
  PatternKit.Structural.Proxy.Proxy<T1, T2>                                      98.8%

PatternKit.Examples                                                                80%
  PatternKit.Examples.ApiGateway.Demo                                            97.9%
  PatternKit.Examples.ApiGateway.MiniRouter                                      96.6%
  PatternKit.Examples.ApiGateway.Request                                           75%
  PatternKit.Examples.ApiGateway.Response                                         100%
  PatternKit.Examples.ApiGateway.Responses                                        100%
  PatternKit.Examples.Chain.AuthLoggingDemo                                      95.2%
  PatternKit.Examples.Chain.CardProcessors                                        100%
  PatternKit.Examples.Chain.CardTenderStrategy                                      0%
  PatternKit.Examples.Chain.CashTenderStrategy                                      0%
  PatternKit.Examples.Chain.ChainStage                                            100%
  PatternKit.Examples.Chain.CharityRoundUpRule                                     20%
  PatternKit.Examples.Chain.ConfigDriven.Bundle1OffEach                          14.2%
  PatternKit.Examples.Chain.ConfigDriven.CardTender                              72.2%
  PatternKit.Examples.Chain.ConfigDriven.Cash2Pct                                16.6%
  PatternKit.Examples.Chain.ConfigDriven.CashTender                              90.9%
  PatternKit.Examples.Chain.ConfigDriven.CharityRoundUp                           100%
  PatternKit.Examples.Chain.ConfigDriven.ConfigDrivenPipelineBuilderExtensions   94.2%
  PatternKit.Examples.Chain.ConfigDriven.ConfigDrivenPipelineDemo                 100%
  PatternKit.Examples.Chain.ConfigDriven.Loyalty5Pct                               20%
  PatternKit.Examples.Chain.ConfigDriven.NickelCashOnly                          77.7%
  PatternKit.Examples.Chain.ConfigDriven.PipelineOptions                          100%
  PatternKit.Examples.Chain.Customer                                              100%
  PatternKit.Examples.Chain.DeviceBus                                             100%
  PatternKit.Examples.Chain.GenericProcessor                                      100%
  PatternKit.Examples.Chain.HttpRequest                                           100%
  PatternKit.Examples.Chain.IRoundingRule                                         100%
  PatternKit.Examples.Chain.LineItem                                              100%
  PatternKit.Examples.Chain.MediatedTransactionPipelineDemo                       100%
  PatternKit.Examples.Chain.NickelCashOnlyRule                                    100%
  PatternKit.Examples.Chain.NoopCharityTracker                                      0%
  PatternKit.Examples.Chain.RoundingPipeline                                      100%
  PatternKit.Examples.Chain.Tender                                                100%
  PatternKit.Examples.Chain.TenderRouterFactory                                  91.3%
  PatternKit.Examples.Chain.TransactionContext                                    100%
  PatternKit.Examples.Chain.TransactionPipeline                                   100%
  PatternKit.Examples.Chain.TransactionPipelineBuilder                           92.3%
  PatternKit.Examples.Chain.TxResult                                              100%
  PatternKit.Examples.FacadeDemo.FacadeDemo                                      62.9%
  PatternKit.Examples.FlyweightDemo.FlyweightDemo                                96.9%
  PatternKit.Examples.Generators.IntParser                                         60%
  PatternKit.Examples.Generators.OrderRouter                                     95.2%
  PatternKit.Examples.Generators.ScoreLabeler                                     100%
  PatternKit.Examples.MediatorDemo.AppMediator                                    100%
  PatternKit.Examples.MediatorDemo.AuditLogHandler                                100%
  PatternKit.Examples.MediatorDemo.BoxHelper                                       25%
  PatternKit.Examples.MediatorDemo.CountUpCmd                                     100%
  PatternKit.Examples.MediatorDemo.CountUpHandler                                 100%
  PatternKit.Examples.MediatorDemo.EchoCmd                                        100%
  PatternKit.Examples.MediatorDemo.EchoHandler                                    100%
  PatternKit.Examples.MediatorDemo.LoggingBehavior<T1, T2>                        100%
  PatternKit.Examples.MediatorDemo.MediatorAssemblyScanner                        100%
  PatternKit.Examples.MediatorDemo.MediatorDemoSink                               100%
  PatternKit.Examples.MediatorDemo.MediatorRegistry                               100%
  PatternKit.Examples.MediatorDemo.PingCmd                                        100%
  PatternKit.Examples.MediatorDemo.PingHandler                                    100%
  PatternKit.Examples.MediatorDemo.ServiceCollectionExtensions                   83.3%
  PatternKit.Examples.MediatorDemo.SumCmd                                         100%
  PatternKit.Examples.MediatorDemo.SumCmdBehavior                                 100%
  PatternKit.Examples.MediatorDemo.SumHandler                                     100%
  PatternKit.Examples.MediatorDemo.UserCreated                                    100%
  PatternKit.Examples.MediatorDemo.WelcomeEmailHandler                            100%
  PatternKit.Examples.MementoDemo.MementoDemo                                    83.5%
  PatternKit.Examples.ObserverDemo.EventHub<T>                                      0%
  PatternKit.Examples.ObserverDemo.LineItem                                       100%
  PatternKit.Examples.ObserverDemo.ObservableList<T>                               47%
  PatternKit.Examples.ObserverDemo.ObservableVar<T>                               100%
  PatternKit.Examples.ObserverDemo.ProfileViewModel                               100%
  PatternKit.Examples.ObserverDemo.PropertyChangedHub                             100%
  PatternKit.Examples.ObserverDemo.ReactiveTransaction                           95.4%
  PatternKit.Examples.ObserverDemo.UserEvent                                        0%
  PatternKit.Examples.PointOfSale.CustomerInfo                                    100%
  PatternKit.Examples.PointOfSale.Demo                                              0%
  PatternKit.Examples.PointOfSale.OrderLineItem                                   100%
  PatternKit.Examples.PointOfSale.PaymentProcessorDemo                           94.8%
  PatternKit.Examples.PointOfSale.PaymentReceipt                                  100%
  PatternKit.Examples.PointOfSale.PromotionConfig                                 100%
  PatternKit.Examples.PointOfSale.PurchaseOrder                                   100%
  PatternKit.Examples.PointOfSale.ReceiptLineItem                                 100%
  PatternKit.Examples.PointOfSale.StoreLocation                                   100%
  PatternKit.Examples.Pricing.ApiPricingSource                                    100%
  PatternKit.Examples.Pricing.CharityRoundUpRule                                  100%
  PatternKit.Examples.Pricing.Coupon                                              100%
  PatternKit.Examples.Pricing.DbPricingSource                                     100%
  PatternKit.Examples.Pricing.DefaultSourceRouting                               83.3%
  PatternKit.Examples.Pricing.FilePricingSource                                   100%
  PatternKit.Examples.Pricing.LineItem                                            100%
  PatternKit.Examples.Pricing.Location                                            100%
  PatternKit.Examples.Pricing.LoyaltyMembership                                   100%
  PatternKit.Examples.Pricing.NickelCashOnlyRule                                  100%
  PatternKit.Examples.Pricing.PercentLoyaltyRule                                  100%
  PatternKit.Examples.Pricing.PricingContext                                      100%
  PatternKit.Examples.Pricing.PricingDemo                                        56.7%
  PatternKit.Examples.Pricing.PricingPipeline                                     100%
  PatternKit.Examples.Pricing.PricingPipelineBuilder                              100%
  PatternKit.Examples.Pricing.PricingResult                                       100%
  PatternKit.Examples.Pricing.RegionCategoryTaxPolicy                             100%
  PatternKit.Examples.Pricing.Sku                                                85.7%
  PatternKit.Examples.Pricing.SourceRouter                                       92.3%
  PatternKit.Examples.ProxyDemo.ProxyDemo                                        94.5%
  PatternKit.Examples.Singleton.DeviceRegistry                                    100%
  PatternKit.Examples.Singleton.PosAppState                                       100%
  PatternKit.Examples.Singleton.PosAppStateDemo                                   100%
  PatternKit.Examples.Singleton.PricingCache                                      100%
  PatternKit.Examples.Singleton.StoreConfig                                       100%
  PatternKit.Examples.Strategies.Coercion.Coercer<T>                             83.3%
  PatternKit.Examples.Strategies.Coercion.CoercerExtensions                       100%
  PatternKit.Examples.Strategies.Composed.ChannelPolicy                           100%
  PatternKit.Examples.Strategies.Composed.ChannelPolicyFactory                    100%
  PatternKit.Examples.Strategies.Composed.ComposedStrategies                     94.2%
  PatternKit.Examples.Strategies.Composed.SendContext                             100%
  PatternKit.Examples.Strategies.Composed.SendResult                              100%

PatternKit.Generators                                                            88.2%
  PatternKit.Generators.GenerateStrategyAttribute                                   0%
  PatternKit.Generators.StrategyGenerator                                        93.9%

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Oct 10, 2025

Codecov Report

❌ Patch coverage is 89.09774% with 29 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.52%. Comparing base (9ea109e) to head (05e373c).
⚠️ Report is 83 commits behind head on main.

Files with missing lines Patch % Lines
...tternKit.Core/Behavioral/Observer/AsyncObserver.cs 87.80% 10 Missing ⚠️
...ernKit.Examples/ObserverDemo/ReactivePrimitives.cs 74.19% 8 Missing ⚠️
...PatternKit.Examples/ObserverDemo/SimpleEventHub.cs 0.00% 6 Missing ⚠️
...rnKit.Examples/ObserverDemo/ReactiveTransaction.cs 96.62% 3 Missing ⚠️
...rc/PatternKit.Core/Behavioral/Observer/Observer.cs 96.55% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #54      +/-   ##
==========================================
+ Coverage   76.98%   84.52%   +7.54%     
==========================================
  Files          55       60       +5     
  Lines        4206     4472     +266     
  Branches      636      678      +42     
==========================================
+ Hits         3238     3780     +542     
+ Misses        737      692      -45     
+ Partials      231        0     -231     
Flag Coverage Δ
unittests 84.52% <89.09%> (+7.54%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@JerrettDavis JerrettDavis merged commit 61a4dc0 into main Oct 10, 2025
4 checks passed
@JerrettDavis JerrettDavis deleted the feature/24-fluent-create-observer-pattern branch October 10, 2025 04:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fluent: Create Observer Pattern

3 participants